
//Copyright 1997-2009 Syrinx Development, Inc.
//This file is part of the Syrinx Web Application Framework (SWAF).
// == BEGIN LICENSE ==
//
// Licensed under the terms of any of the following licenses at your
// choice:
//
//  - GNU General Public License Version 3 or later (the "GPL")
//    http://www.gnu.org/licenses/gpl.html
//
//  - GNU Lesser General Public License Version 3 or later (the "LGPL")
//    http://www.gnu.org/licenses/lgpl.html
//
//  - Mozilla Public License Version 1.1 or later (the "MPL")
//    http://www.mozilla.org/MPL/MPL-1.1.html
//
// == END LICENSE ==
using System;

namespace Swaf
{
	/// <summary>
	/// Summary description for IDescriptive.
	/// </summary>
	public interface IDescriptive
	{
		/// <summary>
		/// The most simplest display text for the element that should be no longer than 2 or
		/// 3 words.  This is suitable for display in tabs, buttons, and other small name display
		/// areas.</summary>
		string ShortName {get;}

		/// <summary>
		/// A more verbose display text then <c>shortName</c> that should be no longer than a small
		/// sentence.  This is suitable for display in hot tips, status bars, and other medium name
		/// display areas.</summary>
		string MediumName {get;}

		/// <summary>
		/// A description of the element that should be no longer than a paragraph or two.
		/// This is suitable for display in description areas and other larger text display
		/// areas.</summary>
		string Description {get;}
	}
}
